<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>aws-crt-cpp: Contributing Guidelines</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">aws-crt-cpp
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="PageDoc"><div class="header">
  <div class="headertitle">
<div class="title">Contributing Guidelines </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.</p>
<p>Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.</p>
<h1><a class="anchor" id="autotoc_md2"></a>
Reporting Bugs/Feature Requests</h1>
<p>We welcome you to use the GitHub issue tracker to report bugs or suggest features.</p>
<p>When filing an issue, please check <a href="https://github.com/awslabs/aws-crt-cpp/issues">existing open</a>, or <a href="https://github.com/awslabs/aws-crt-cpp/issues?utf8=%E2%9C%93&amp;q=is%3Aissue%20is%3Aclosed%20">recently closed</a>, issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:</p>
<ul>
<li>A reproducible test case or series of steps</li>
<li>The version of our code being used</li>
<li>Any modifications you've made relevant to the bug</li>
<li>Anything unusual about your environment or deployment</li>
</ul>
<h1><a class="anchor" id="autotoc_md3"></a>
Contributing via Pull Requests</h1>
<p>Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:</p>
<ol type="1">
<li>You are working against the latest source on the <em>master</em> branch.</li>
<li>You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.</li>
<li>You open an issue to discuss any significant work - we would hate for your time to be wasted.</li>
</ol>
<p>To send us a pull request, please:</p>
<ol type="1">
<li>Fork the repository.</li>
<li>Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.</li>
<li>Ensure local tests pass.</li>
<li>Commit to your fork using clear commit messages.</li>
<li>Send us a pull request, answering any default questions in the pull request interface.</li>
<li>Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.</li>
</ol>
<p>GitHub provides additional document on <a href="https://help.github.com/articles/fork-a-repo/">forking a repository</a> and <a href="https://help.github.com/articles/creating-a-pull-request/">creating a pull request</a>.</p>
<h1><a class="anchor" id="autotoc_md4"></a>
Finding contributions to work on</h1>
<p>Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any <a href="https://github.com/awslabs/aws-crt-cpp/labels/help%20wanted">'help wanted'</a> issues is a great place to start.</p>
<h1><a class="anchor" id="autotoc_md5"></a>
Code of Conduct</h1>
<p>This project has adopted the <a href="https://aws.github.io/code-of-conduct">Amazon Open Source Code of Conduct</a>. For more information see the <a href="https://aws.github.io/code-of-conduct-faq">Code of Conduct FAQ</a> or contact <a href="#" onclick="location.href='mai'+'lto:'+'ope'+'ns'+'our'+'ce'+'-co'+'de'+'ofc'+'on'+'duc'+'t@'+'ama'+'zo'+'n.c'+'om'; return false;">opens<span style="display: none;">.nosp@m.</span>ourc<span style="display: none;">.nosp@m.</span>e-cod<span style="display: none;">.nosp@m.</span>eofc<span style="display: none;">.nosp@m.</span>onduc<span style="display: none;">.nosp@m.</span>t@am<span style="display: none;">.nosp@m.</span>azon.<span style="display: none;">.nosp@m.</span>com</a> with any additional questions or comments.</p>
<h1><a class="anchor" id="autotoc_md6"></a>
Security issue notifications</h1>
<p>If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our <a href="http://aws.amazon.com/security/vulnerability-reporting/">vulnerability reporting page</a>. Please do <b>not</b> create a public github issue.</p>
<h1><a class="anchor" id="autotoc_md7"></a>
Licensing</h1>
<p>See the <a href="https://github.com/awslabs/aws-crt-cpp/blob/master/LICENSE">LICENSE</a> file for our project's licensing. We will ask you to confirm the licensing of your contribution.</p>
<p>We may ask you to sign a <a href="http://en.wikipedia.org/wiki/Contributor_License_Agreement">Contributor License Agreement (CLA)</a> for larger changes. </p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.18
</small></address>
</body>
</html>
